Conversation
jkuelz
requested review from
amanabiy and
cansuaa
and removed request for
a team
jkuelz
force-pushed
the
jkuelz-core-style-descriptions
branch
from
e46ef5b to
4487df0
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #111 +/- ##
=======================================
Coverage 96.31% 96.31%
=======================================
Files 30 30
Lines 705 705
Branches 133 133
=======================================
Hits 679 679
Misses 26 26 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| hideAvatar?: boolean; | ||
|
|
||
| /** | ||
| * An object containing CSS properties to customize the chat bubble's visual appearance. | ||
| * @awsuiSystem core | ||
| */ | ||
| style?: ChatBubbleProps.Style; |
There was a problem hiding this comment.
Where do we expect this to description to be shown?
I noticed our documentation already includes a default style description that links to the style tab (see example).
We are not adding it so far because it is added in the website.
There was a problem hiding this comment.
Anywhere where we rely on the documenter definitions (website playground prop popover, website API tab, Venue configurator, etc.). It is hardcoded in the website API table, which is fragile because it means it is an exception and we would need to do this everywhere; otherwise it will appear empty, like in the playground popover, for example:
FYI - I've added the same update in the components package.
To your point though, I've added another sentence which links to the style tab so we don't lose the previous API table description.
2 participants
Description
This adds descriptions to style API to be picked up by documenter. We use descriptions in tooling like our website playground and other configurators, this is to prevent them from appearing empty.
How has this been tested?
Review checklist
The following items are to be evaluated by the author(s) and the reviewer(s).
Correctness
CONTRIBUTING.md.CONTRIBUTING.md.Security
checkSafeUrlfunction.Testing
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.